home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 February / EnigmA AMIGA RUN 15 (1997)(G.R. Edizioni)(IT)[!][issue 1997-02][PLANET CD V].iso / enigma / earcd / utility / utilfile / dosummin.lha / DoSomething / DoSomething.doc < prev    next >
Text File  |  1996-11-13  |  7KB  |  192 lines
  1.                     ***************************************
  2.  
  3.                     DoSomething 1.0 - A file action program
  4.  
  5.                              by Maarten C. ter Mors
  6.                               (mcmors@cornnet.nl)
  7.  
  8.                     ***************************************
  9.  
  10.  
  11.  
  12.  
  13.                    'Don't just stand there -- DO SOMETHING !'
  14.  
  15.                                         - hysterical wife to
  16.                                           her helpless husband
  17.  
  18.  
  19.  
  20.  
  21. Legal mumbo jumbo
  22. -----------------
  23. This program is distributed as Freeware, which means to say you may and are
  24. encouraged to copy it freely and give it to other people.  This includes
  25. uploading the software to BBS systems, FTP sites et cetera.  You may also
  26. include it on magazine cover disks / CDs and on Amiga PD CDs, such as the Aminet
  27. series.  You must, however, keep the original program, source and documentation
  28. intact if you distribute the program.
  29. You are NOT allowed to make any profit from the distribution of this program and
  30. you may ONLY use it as part of a commercial distribution with written permission
  31. from the author.
  32. You may use the source and the program itself in your own (non-commercial)
  33. software, just so long as you mention the name of its original author, Maarten
  34. ter Mors.
  35. The program, source and documentation remain © Copyright 1996 by M.C. ter Mors.
  36.  
  37.  
  38.  
  39.  
  40. What is it ?
  41. ------------
  42. DoSomething is a small program for the Commodore Amiga range of computers,
  43. which will presumably also run on Amiga compatible clones and emulators.  The
  44. only system requirements are Kickstart 2.04 (V37) or higher and a file system
  45. that supports file notification (e.g. FFS, AFS etc.).
  46. With this program you can let the Amiga perform actions automatically as and
  47. when files and/or the contents of a directory change.  To do this, it uses a
  48. standard feature of the OS called file notification.  For more information on
  49. this, please refer to the DOS autodoc.
  50.  
  51.  
  52.  
  53. Why do I need it ?
  54. ------------------
  55. There has been a number of situations in which I found myself performing actions
  56. on files after they had downloaded, rendered or grabbed from my digitizer. 
  57. Simple examples are unpacking archives into my test directory, moving rendered
  58. or grabbed frames to a different location under a different name, and so on.
  59. In many cases, it would be very easy if you could have these actions performed
  60. automatically.  Another possible use would be to keep an eye on certain files to
  61. see if they change, e.g. your startup files or your LIBS: directory.
  62.  
  63.  
  64.  
  65. How do I use it ?
  66. -----------------
  67. It's easy, really.  The template for DoSomething is:
  68.  
  69.     DoSomething FILES/M,ACTION/K,CONFIG/K
  70.  
  71. where
  72.  
  73.     FILES/M     The files or directories to perform the action on.  This may be
  74.                 any number of files.  If you use many files, however, you might
  75.                 be better off putting them in a configuration file instead of
  76.                 typing them on the command line (see below for configuration
  77.                 options).
  78.  
  79.     ACTION/K    The action to perform, as an AmigaDOS command.  This can be a
  80.                 "dir", for example, but you can also start scripts or programs.
  81.                 Just make sure the string behind ACTION is the same what you
  82.                 would type in the shell.
  83.                 As an extra option, you can specify _ONE_ occurence of the
  84.                 sub-string %s in your ACTION string.  DoSomething will
  85.                 substitute the name of the object the notify took place on here.
  86.                 Note that if the original notify was on a directory, the
  87.                 filesystem will only return the name of that directory.
  88.  
  89.  
  90.                 NOTE 1: The settings for the executed command are:
  91.                         Stack 4096, Input & Output >NIL:
  92.                         If you require a different (i.e. larger) stack size,
  93.                         you should make a script file like
  94.  
  95.  
  96.                         ; Script to set stack and run program
  97.                         Stack 100000            ; Example value
  98.                         MyProgram
  99.  
  100.  
  101.                         The Input and Output may of course still be redirected
  102.                         with the > and < operators as usual.
  103.  
  104.  
  105.                 NOTE 2: You cannot use additional quotes in the action string.
  106.                         This is because ReadArgs() parses the input and it can't
  107.                         handle strings-within-strings, to my knowledge.  Once
  108.                         again, you'd have to make a script.
  109.  
  110.  
  111.                 NOTE 3: You must specify the ACTION keyword.
  112.  
  113.  
  114.     Examples:
  115.     ---------
  116.  
  117.         1> DoSomething FILES RAM: ACTION "Dir >CON: %s"
  118.  
  119.     Shows the directory of RAM: when a new file is written to it.
  120.  
  121.         1> DoSomething FILES LIBS:mathieee.library LIBS:mathffp.library
  122.             ACTION "Execute S:StartDOpus"
  123.  
  124.     Starts a script in S: that (presumably) in turn starts Directory Opus, as
  125.     soon as somebody messes with your math libraries.  (Hey, nobody said these
  126.     examples had to make sense :-).
  127.  
  128.  
  129.  
  130.     CONFIG/K    Specifies the name of a configuration file.  Once again, you
  131.                 have to specify the keyword CONFIG explicitly.  If you use this
  132.                 option, you may omit the FILES and ACTION options.
  133.  
  134.                 The format of the configuration file is simple.  Each line is a
  135.                 combination of a FILES list of names and an ACTION, just as
  136.                 you'd type on the command line.  So, an example configuration
  137.                 would be:
  138.  
  139.  
  140.                 FILES RAM: ACTION "PlaySound Work:Music/Samples/OYeah"
  141.                 FILES S:User-Startup ACTION "GetEnv >CON:0/0////WAIT PPPIPLocal"
  142.                 FILES L:File1 T:File6 SYS:System ACTION NewShell
  143.  
  144.  
  145.                 and so on.  Theoretically, there is no limit to the amount of
  146.                 lines.
  147.                 You are advised not to insert any non-command lines in the
  148.                 configuration file, like comments etc.  Incomplete lines, i.e.
  149.                 without both a valid file list and an ACTION keyword shouldn't
  150.                 actually do anything, but this has not been thoroughly tested.
  151.                 So be prepared for unpredictable results if you specify bogus
  152.                 lines in your config file.
  153.  
  154.  
  155. Something else you might like to know, is that DoSomething automatically
  156. detaches from the Shell it was started from.  This makes it perfect to be
  157. started from S:User-Startup.
  158.  
  159.  
  160.  
  161. Why is this manual crap ?
  162. -------------------------
  163. Because I don't like to write manuals, especially not for these small tools. 
  164. Besides, there's not too much to tell about this program.  If you have any
  165. questions, contact me (below).
  166.  
  167.  
  168.  
  169. Who wrote this marvel ?
  170. -----------------------
  171. Maarten Cornelis ter Mors
  172. Schubertlaan 52
  173. 2625 VE Delft
  174. The Netherlands
  175.  
  176. email: mcmors@cornnet
  177.  
  178.  
  179. Feel free to contact me by either snailmail or email if you have anything to
  180. ask, add or complain.
  181.  
  182.  
  183.  
  184. Signing off,
  185.  
  186.     /|/|       ___  /|/|
  187.    / | |aarten |er / | |ors
  188.  
  189.  
  190.  
  191.  
  192.